Cuminas DjVu SDK for .NET Framework
AddPage(Image,Int32,EncoderParams,Byte[],Int32,Int32,MaskType) Method



Image object to encode.
Image/mask resolution in dot-per-inch.
Parameters to configure the encoding parameter for the page. It can be null to use the global parameter specified to the Encoder object.
A Byte array, which contains the page mask image. It can be null if you don't need any mask (just compressing Photo).

The offset in the array where the left-top pixel of the mask image is.

It should be 0 if no mask is specified (maskArr is null).

Mask image stride, which is also known as bytes-per-line. It can be even negative value if it meets the following rule:

line_ptr[n+1] = line_ptr[n] + maskRowStride

It should be 0 if no mask is specified (mask is null).

Mask type; one of MaskType enumeration values.

It can be any value if no mask is specified (mask is null).

Add a new page by specifying an Image object.
Syntax
Public Overloads Sub AddPage( _
   ByVal image As Image, _
   ByVal dpi As Integer, _
   ByVal params As EncoderParams, _
   ByVal maskArr() As Byte, _
   ByVal maskOffset As Integer, _
   ByVal maskRowStride As Integer, _
   ByVal maskType As MaskType _
) 
Dim instance As Encoder
Dim image As Image
Dim dpi As Integer
Dim params As EncoderParams
Dim maskArr() As Byte
Dim maskOffset As Integer
Dim maskRowStride As Integer
Dim maskType As MaskType
 
instance.AddPage(image, dpi, params, maskArr, maskOffset, maskRowStride, maskType)

Parameters

image
Image object to encode.
dpi
Image/mask resolution in dot-per-inch.
params
Parameters to configure the encoding parameter for the page. It can be null to use the global parameter specified to the Encoder object.
maskArr
A Byte array, which contains the page mask image. It can be null if you don't need any mask (just compressing Photo).
maskOffset

The offset in the array where the left-top pixel of the mask image is.

It should be 0 if no mask is specified (maskArr is null).

maskRowStride

Mask image stride, which is also known as bytes-per-line. It can be even negative value if it meets the following rule:

line_ptr[n+1] = line_ptr[n] + maskRowStride

It should be 0 if no mask is specified (mask is null).

maskType

Mask type; one of MaskType enumeration values.

It can be any value if no mask is specified (mask is null).

Requirements

Target Platforms: Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

Reference

Encoder Class
Encoder Members
Overload List

Send Feedback